IApi.WriteAxisAlias method

Writes an alias index into an axis. The alias index allows you to reorder the list of axes if the cabling doesn't match the program.

Assembly: IntervalZero.KINGSTAR.Base.Api (in IntervalZero.KINGSTAR.Base.dll) Version: 4.4.0.0

Syntax

KsError WriteAxisAlias(
       int Index,
       int Alias
)

Function WriteAxisAlias(
       Index As Integer,
       Alias As Integer
) As KsError

Parameters

Index

Type: int

The index of an axis. Indexes are zero based. Aliases affect this parameter.

Alias

Type: int

The alias index for the axis to replace the index in the axis list. Indexes are zero based.

Return value

Type: KsError

A return code of a method.

Remarks

• Reorders axes. Use it after the KINGSTAR Subsystem is started.
• The alias index can be outside the actual index range of the axes.

Usable EtherCAT states

ecatOP

Examples

N/A

See also

IApi Interface

IntervalZero.KINGSTAR.Base.Api Namespace